1. Pre-requisites

• node.js 4+ (npm is included in the package)

2. Add mock dependency to package.json

"dependencies": {
  "testarmada-midway": "^1.0.1"
}

3. Install mock dependency with npm install

Run npm install command to install mock related dependencies.

4. Add resources/endpoints.js and create ./resources/mocked-data directory to store the mock data.

require('./endpoints');
require('midway').start({
  host: "localhost",
  mockedDirectory: "./resources/mocked-data",
  port: 8000,
  project: 'HelloMidway'
});

5. Add resources/run-mock-server-console.js

require('./endpoints');
require('midway').start({
  host: "localhost",
  mockedDirectory: "./resources/mocked-data",
  port: 8000,
  project: 'HelloMidway'
});

Please note that you will need to replace HelloMidway for key project field with your project name(without dashes).

6. Add script to start mock server in package.json

"scripts": {
  "lint": "eslint . --ext .js",
  "start-server": "node ./resources/run-mock-server-console.js"
},

7. Test mock server can be started

npm run start-server